rest-client 1.6.1 → 1.6.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 317f1bdcf77b2dae0fe9a08a165a56c71fb9c3d79b71c8d6c5a12cb1e4868a4e
+  data.tar.gz: d2a662189817597ff1fca0e6685cdd5d06bdac1ca72bf9a932f1d7def456b26b
+SHA512:
+  metadata.gz: f789e7291285e26aa719119331d0d1a6322ec618a25eb2626a1a8486e3584fb07e52d25dfb7a56972cb495e5e2cad6c67eae5f3da98d66974d51f3c4fc2566f1
+  data.tar.gz: cf43508dbbc1f6977b3e8ad047651591760b8f386e3daa472888fc81f262b3d2669798f847b88fdd7b6f6f77b2a44990688c88efc53e02072bb9f284459c6b41

data/.gitignore

@@ -0,0 +1,8 @@
+.idea
+.rvmrc
+doc
+rdoc
+pkg
+*.gem
+scratchpad.rb
+/Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--colour --format progress --order random

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.8.7"

data/AUTHORS

@@ -0,0 +1,75 @@
+The Ruby REST Client would not be what it is today without the help of
+the following kind souls:
+
+Adam Jacob
+Adam Wiggins
+Aman Gupta
+Andy Brody
+Blake Mizerany
+Brad Ediger
+Braintree
+Brian Donovan
+Caleb Land
+Chris Dinn
+Chris Green
+Coda Hale
+Crawford
+Cyril Rohr
+Dan Mayer
+David Backeus
+Dmitri Dolguikh
+Dusty Doris
+Dylan Egan
+El Draper
+Evan Smith
+François Beausoleil
+Gabriele Cirulli
+Garry Shutler
+Giovanni Cappellotto
+Greg Borenstein
+Harm Aarts
+Hiro Asari
+Hugh McGowan
+Ian Warshak
+Ivan Makfinsky
+James Edward Gray II
+Jari Bakken
+Jeff Remer
+JH. Chabran
+John Barnette
+Jon Rowe
+Jordi Massaguer Pla
+Juan Alvarez
+Julien Kirch
+Justin Coyne
+Keith Rarick
+Kenichi Kamiya
+Kevin Read
+Kosuke Asami
+Kyle VanderBeek
+Lars Gierth
+Lawrence Leonard Gilbert
+Lee Jarvis
+Lennon Day-Reynolds
+macournoyer
+Matthew Manning
+Michael Klett
+Mike Fletcher
+Nicholas Wieland
+Nick Plante
+Niko Dittmann
+Oscar Del Ben
+Pablo Astigarraga
+Paul Dlug
+Pedro Belo
+rafael.ssouza
+Philip Corliss
+Rick "technoweenie"
+Robert Eanes
+Rodrigo Panachi
+Syl Turner
+T. Watanabe
+Tekin
+tpresa
+W. Andrew Loe III
+Waynn Lue

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/README.rdoc

@@ -1,18 +1,19 @@
 = REST Client -- simple DSL for accessing HTTP and REST resources
 
+Build status: {<img src="https://travis-ci.org/rest-client/rest-client.svg?branch=1.6-legacy" alt="Build Status" />}[https://travis-ci.org/rest-client/rest-client]
+
 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
+* Main page: https://github.com/rest-client/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}
@@ -79,10 +80,10 @@ 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
+* for result codes between 200 and 207, a RestClient::Response will be returned
+* for result codes 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 known error codes
 
    RestClient.get 'http://example.com/resource'
    ➔ RestClient::ResourceNotFound: RestClient::ResourceNotFound
@@ -96,7 +97,7 @@ See RestClient::Resource docs for details.
 
 == Result handling
 
-A block can be passed to the RestClient method, this block will then be called with the Response.
+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
@@ -128,16 +129,25 @@ Response.return! can be called to invoke the default response's behavior.
     end
   }
 
-== Non-normalized URIs.
+== Non-normalized URIs
 
-If you want to use non-normalized URIs, you can normalize them with the addressable gem (http://addressable.rubyforge.org/api/).
+If you need to normalize URIs, e.g. to work with International Resource Identifiers (IRIs),
+use the addressable gem (http://addressable.rubyforge.org/api/) in your code:
 
   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::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 provides a lower-level API.
+
+You can:
+
+* specify ssl parameters
+* override cookies
+* manually handle the response (e.g. to operate on it as a stream rather than reading it all into memory)
+
+See RestClient::Request's documentation for more information.
 
 == Shell
 
@@ -179,10 +189,10 @@ Use as a one-off, curl-style:
 
 == Logging
 
-To enable logging you can
+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"):
+* 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
 
@@ -205,11 +215,19 @@ RestClient.proxy:
   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
+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']
 
+== Query parameters
+
+Request objects know about query parameters and will automatically add them to
+the URL for GET, HEAD and DELETE requests, escaping the keys and values as needed:
+
+  RestClient.get 'http://example.com/resource', :params => {:foo => 'bar', :baz => 'qux'}
+  # will GET http://example.com/resource?foo=bar&baz=qux
+
 == Cookies
 
 Request and Response objects know about HTTP cookies, and will automatically
@@ -240,11 +258,12 @@ 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.
+RestClient.add_before_execution_proc add a Proc to be called before each execution.
+It's handy if you need direct access to the HTTP request.
 
 Example:
 
-  # Add oath support using the oauth gem
+  # Add oauth support using the oauth gem
   require 'oauth'
   access_token = ...
 
@@ -256,14 +275,26 @@ Example:
 
 == More
 
-Need caching, more advanced logging or any ability provided by a rack middleware ?
+Need caching, more advanced logging or any ability provided by Rack middleware?
+
+Have a look at rest-client-components: http://github.com/crohr/rest-client-components
+
+== Credits
 
-Have a look at rest-client-components http://github.com/crohr/rest-client-components
+REST Client Team:: Matthew Manning, Lawrence Leonard Gilbert, Andy Brody
 
-== Meta
+Creator:: Adam Wiggins
 
-Written by Adam Wiggins, major modifications by Blake Mizerany, maintained by Julien Kirch
+Maintainer Emeritus:: Julien Kirch
+
+Major contributions:: Blake Mizerany, 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.
 
+== Legal
+
 Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+"Master Shake" photo (http://www.flickr.com/photos/solgrundy/924205581/) by
+"SolGrundy"; used under terms of the Creative Commons Attribution-ShareAlike 2.0
+Generic license (http://creativecommons.org/licenses/by-sa/2.0/)

data/Rakefile

@@ -1,53 +1,33 @@
-require 'rake'
-
-require 'jeweler'
-
-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.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_development_dependency("webmock", ">= 0.9.1")
-  s.add_development_dependency("rspec")
+begin
+  # optionally load `rake build/install/release tasks'
+  require 'bundler/gem_tasks'
+rescue LoadError
 end
 
-Jeweler::RubyforgeTasks.new
-
-############################
-
-require 'spec/rake/spectask'
+require "rspec/core/rake_task"
 
 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']
+RSpec::Core::RakeTask.new('spec:unit') do |t|
+  t.pattern = ['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']
+RSpec::Core::RakeTask.new('spec:integration') do |t|
+  t.pattern = ['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']
+RSpec::Core::RakeTask.new(:doc) do |t|
+  t.rspec_opts = ["--format", "specdoc", "--dry-run"]
+  t.pattern = ['spec/*_spec.rb']
 end
 
 desc "Run all examples with RCov"
-Spec::Rake::SpecTask.new('rcov') do |t|
-  t.spec_files = FileList['spec/*_spec.rb']
+RSpec::Core::RakeTask.new('rcov') do |t|
+  t.pattern = ['spec/*_spec.rb']
   t.rcov = true
   t.rcov_opts = ['--exclude', 'examples']
 end
@@ -56,7 +36,7 @@ task :default => :spec
 
 ############################
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 Rake::RDocTask.new do |t|
   t.rdoc_dir = 'rdoc'

data/bin/restclient

@@ -1,22 +1,25 @@
 #!/usr/bin/env ruby
 
 $:.unshift File.dirname(__FILE__) + "/../lib"
-require 'restclient'
 
-require "yaml"
+require 'rubygems'
+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 +27,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)
+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