RubyGems - rest-client - Versions diffs - 1.6.7 → 2.1.0 - Mend

rest-client 1.6.7 → 2.1.0

Files changed (77) hide show

checksums.yaml +7 -0
data/.gitignore +9 -0
data/.mailmap +10 -0
data/.rspec +2 -0
data/.rubocop +2 -0
data/.rubocop-disables.yml +386 -0
data/.rubocop.yml +8 -0
data/.travis.yml +62 -0
data/AUTHORS +106 -0
data/Gemfile +11 -0
data/LICENSE +21 -0
data/README.md +901 -0
data/Rakefile +109 -35
data/bin/restclient +11 -12
data/history.md +244 -1
data/lib/restclient.rb +27 -18
data/lib/restclient/abstract_response.rb +197 -51
data/lib/restclient/exceptions.rb +110 -59
data/lib/restclient/params_array.rb +72 -0
data/lib/restclient/payload.rb +74 -75
data/lib/restclient/platform.rb +49 -0
data/lib/restclient/raw_response.rb +21 -6
data/lib/restclient/request.rb +747 -183
data/lib/restclient/resource.rb +22 -13
data/lib/restclient/response.rb +75 -9
data/lib/restclient/utils.rb +274 -0
data/lib/restclient/version.rb +8 -0
data/lib/restclient/windows.rb +8 -0
data/lib/restclient/windows/root_certs.rb +105 -0
data/rest-client.gemspec +32 -0
data/rest-client.windows.gemspec +19 -0
data/spec/ISS.jpg +0 -0
data/spec/helpers.rb +54 -0
data/spec/integration/_lib.rb +1 -0
data/spec/integration/capath_digicert/3513523f.0 +22 -0
data/spec/integration/capath_digicert/399e7759.0 +22 -0
data/spec/integration/capath_digicert/README +8 -0
data/spec/integration/capath_digicert/digicert.crt +22 -0
data/spec/integration/capath_verisign/415660c1.0 +14 -0
data/spec/integration/capath_verisign/7651b327.0 +14 -0
data/spec/integration/capath_verisign/README +8 -0
data/spec/integration/capath_verisign/verisign.crt +14 -0
data/spec/integration/certs/digicert.crt +22 -0
data/spec/integration/httpbin_spec.rb +128 -0
data/spec/integration/integration_spec.rb +118 -0
data/spec/integration/request_spec.rb +109 -7
data/spec/spec_helper.rb +29 -0
data/spec/unit/_lib.rb +1 -0
data/spec/unit/abstract_response_spec.rb +145 -0
data/spec/unit/exceptions_spec.rb +108 -0
data/spec/unit/params_array_spec.rb +36 -0
data/spec/unit/payload_spec.rb +295 -0
data/spec/unit/raw_response_spec.rb +22 -0
data/spec/unit/request2_spec.rb +54 -0
data/spec/unit/request_spec.rb +1238 -0
data/spec/unit/resource_spec.rb +134 -0
data/spec/unit/response_spec.rb +252 -0
data/spec/unit/restclient_spec.rb +80 -0
data/spec/unit/utils_spec.rb +147 -0
data/spec/unit/windows/root_certs_spec.rb +22 -0
metadata +265 -117
data/README.rdoc +0 -285
data/VERSION +0 -1
data/lib/restclient/net_http_ext.rb +0 -55
data/spec/abstract_response_spec.rb +0 -85
data/spec/base.rb +0 -16
data/spec/exceptions_spec.rb +0 -98
data/spec/integration/certs/equifax.crt +0 -19
data/spec/integration_spec.rb +0 -38
data/spec/master_shake.jpg +0 -0
data/spec/payload_spec.rb +0 -234
data/spec/raw_response_spec.rb +0 -17
data/spec/request2_spec.rb +0 -40
data/spec/request_spec.rb +0 -529
data/spec/resource_spec.rb +0 -134
data/spec/response_spec.rb +0 -169
data/spec/restclient_spec.rb +0 -73

data/README.rdoc DELETED Viewed

@@ -1,285 +0,0 @@
-= 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).
-== 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']
-== Query parameters
-Request objects know about query parameters and will automatically add them to
-the url for GET, HEAD and DELETE requests and escape 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
-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/VERSION DELETED Viewed

	@@ -1 +0,0 @@
1	- 1.6.6

data/lib/restclient/net_http_ext.rb DELETED Viewed

@@ -1,55 +0,0 @@
-module Net
-  class HTTP
-  # Adding the patch method if it doesn't exist (rest-client issue: https://github.com/archiloque/rest-client/issues/79)
-  if !defined?(Net::HTTP::Patch)
-    # Code taken from this commit: https://github.com/ruby/ruby/commit/ab70e53ac3b5102d4ecbe8f38d4f76afad29d37d#lib/net/http.rb
-    class Protocol
-      # Sends a PATCH request to the +path+ and gets a response,
-      # as an HTTPResponse object.
-      def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
-        send_entity(path, data, initheader, dest, Patch, &block)
-      end
-      # Executes a request which uses a representation
-      # and returns its body.
-      def send_entity(path, data, initheader, dest, type, &block)
-        res = nil
-        request(type.new(path, initheader), data) {|r|
-          r.read_body dest, &block
-          res = r
-        }
-        unless @newimpl
-          res.value
-          return res, res.body
-        end
-        res
-      end
-    end
-    class Patch < HTTPRequest
-      METHOD = 'PATCH'
-      REQUEST_HAS_BODY = true
-      RESPONSE_HAS_BODY = true
-    end
-  end
-    #
-    # Replace the request method in Net::HTTP to sniff the body type
-    # and set the stream if appropriate
-    #
-    # Taken from:
-    # http://www.missiondata.com/blog/ruby/29/streaming-data-to-s3-with-ruby/
-    alias __request__ request
-    def request(req, body=nil, &block)
-      if body != nil && body.respond_to?(:read)
-        req.body_stream = body
-        return __request__(req, nil, &block)
-      else
-        return __request__(req, body, &block)
-      end
-    end
-  end
-end

data/spec/abstract_response_spec.rb DELETED Viewed

@@ -1,85 +0,0 @@
-require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
-describe RestClient::AbstractResponse do
-  class MyAbstractResponse
-    include RestClient::AbstractResponse
-    attr_accessor :size
-    def initialize net_http_res, args
-      @net_http_res = net_http_res
-      @args = args
-    end
-  end
-  before do
-    @net_http_res = mock('net http response')
-    @response = MyAbstractResponse.new(@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 "has a nice description" do
-    @net_http_res.should_receive(:to_hash).and_return({'Content-Type' => ['application/pdf']})
-    @net_http_res.should_receive(:code).and_return('200')
-    @response.description == '200 OK | application/pdf  bytes\n'
-  end
-  it "beautifies the headers by turning the keys to symbols" do
-    h = RestClient::AbstractResponse.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::AbstractResponse.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 "extract strange cookies" do
-    @net_http_res.should_receive(:to_hash).and_return('set-cookie' => ['session_id=ZJ/HQVH6YE+rVkTpn0zvTQ==; path=/'])
-    @response.cookies.should == { 'session_id' => 'ZJ%2FHQVH6YE+rVkTpn0zvTQ%3D%3D' }
-  end
-  it "doesn't escape cookies" do
-    @net_http_res.should_receive(:to_hash).and_return('set-cookie' => ['session_id=BAh7BzoNYXBwX25hbWUiEGFwcGxpY2F0aW9uOgpsb2dpbiIKYWRtaW4%3D%0A--08114ba654f17c04d20dcc5228ec672508f738ca; path=/'])
-    @response.cookies.should == { 'session_id' => 'BAh7BzoNYXBwX25hbWUiEGFwcGxpY2F0aW9uOgpsb2dpbiIKYWRtaW4%3D%0A--08114ba654f17c04d20dcc5228ec672508f738ca' }
-  end
-  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/base.rb DELETED Viewed

@@ -1,16 +0,0 @@
-def is_ruby_19?
-  RUBY_VERSION == '1.9.1' or RUBY_VERSION == '1.9.2'
-end
-Encoding.default_internal = Encoding.default_external = "ASCII-8BIT" if is_ruby_19?
-require 'rubygems'
-require 'spec'
-begin
-  require "ruby-debug"
-rescue LoadError
-  # NOP, ignore
-end
-require File.dirname(__FILE__) + '/../lib/restclient'

data/spec/exceptions_spec.rb DELETED Viewed

@@ -1,98 +0,0 @@
-require File.join( File.dirname(File.expand_path(__FILE__)), 'base')
-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
-  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::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')
-  end
-  it "stores the http response on the exception" do
-    response = "response"
-    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
-    RestClient::RequestFailed.new(@response).http_code.should == 502
-    RestClient::RequestFailed.new(@response).message.should == 'HTTP status code 502'
-  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
-    response = "response"
-    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
-  it "make the exception's response act like an Net::HTTPResponse" do
-    body = "body"
-    stub_request(:get, "www.example.com").to_return(:body => body, :status => 404)
-    begin
-      RestClient.get "www.example.com"
-      raise
-    rescue RestClient::ResourceNotFound => e
-      e.response.body.should == body
-    end
-  end
-end