rest-client 2.0.0.rc1 → 2.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 794ed2e11b0716ada13b32030f28b41a73fb0d8a
-  data.tar.gz: 72d955648c12a37a8d44fb024a94c2d490b5216f
+  metadata.gz: 96905e3d1e6d50b89220b2d81fbf057e2e560273
+  data.tar.gz: 1c16a11c16b30878c6d1927fa7b183f9d46fb502
 SHA512:
-  metadata.gz: b8be8c02f82f4a02b8641d8d2f0d5e8055d9fbd563dfde908d9d364966dd49a81dada859906c37a93fb0c75a4beacf8ef91f45050f7be2426371eeec5871eda7
-  data.tar.gz: dd77062a891eb9e90cbd6b4c0b6e31ef3148fb2249f628f588907b433cc92ed435aea107d34452b6a8ba6a214c719f20c62c1bb8e10997a04495b02a3093a796
+  metadata.gz: cc2cf0fa39a6c76dd20ab12e213c05c51cd6158751d76fe0d912783c8762fc116fdaa8a2b6395fdbf5788495f6a28596bacc16616a2041e1de4a999543e559fc
+  data.tar.gz: f2048aadadb9a828cf370ac0a5f670f9115673a5732b06a31e2a296ccf7e1ba93e0d3b755606d6aa54fd6d007683f4229bbacbd88f930c90db29b72003adc8cc

data/AUTHORS

@@ -82,6 +82,7 @@ Rafael Ssouza
 Rick Olson
 Robert Eanes
 Rodrigo Panachi
+Samuel Cochran
 Syl Turner
 T. Watanabe
 Tekin

data/README.rdoc

@@ -8,6 +8,12 @@ of specifying actions: get, put, post, delete.
 * Main page: https://github.com/rest-client/rest-client
 * Mailing list: rest.client@librelist.com (send a mail to subscribe).
 
+=== Mailing list changes
+
+The Librelist mailing list is currently *defunct*, as Librelist appears to be
+broken and not accepting new mail. We will choose a new email list provider
+soon.
+
 == Requirements
 
 MRI Ruby 1.9.3 and newer are supported. Alternative interpreters compatible with
@@ -74,6 +80,10 @@ helpers are just thin wrappers around RestClient::Request.execute.
   RestClient::Request.execute(method: :get, url: 'http://example.com/resource',
                               timeout: 10)
 
+  RestClient::Request.execute(method: :get, url: 'http://example.com/resource',
+                              ssl_ca_file: 'myca.pem',
+                              ssl_ciphers: 'AESGCM:!aNULL')
+
 You can also use this to pass a payload for HTTP verbs like DELETE, where the
 RestClient.delete helper doesn't accept a payload.
 
@@ -332,7 +342,15 @@ extract and set headers for them as needed:
   )
   # ...response body
 
-== SSL Client Certificates
+== SSL/TLS support
+
+Various options are supported for configuring rest-client's TLS settings. By
+default, rest-client will verify certificates using the system's CA store on
+all platforms. (This is intended to be similar to how browsers behave.) You can
+specify an :ssl_ca_file, :ssl_ca_path, or :ssl_cert_store to customize the
+certificate authorities accepted.
+
+=== SSL Client Certificates
 
   RestClient::Resource.new(
     'https://example.com',

data/history.md

@@ -9,11 +9,17 @@ This release is largely API compatible, but makes several breaking changes.
   For example, `Content-Type: text/plain; charset=EUC-JP` will return a String
   encoded with `Encoding::EUC_JP`.
 - Change exceptions raised on request timeout. Instead of
-  RestClient::RequestTimeout (which is still used for HTTP 408), network
-  timeouts will now raise either RestClient::Exceptions::ReadTimeout or
-  RestClient::Exceptions::OpenTimeout, both of which inherit from
-  RestClient::Exceptions::Timeout. This class also makes the original wrapped
-  exception available as `#original_exception`.
+  `RestClient::RequestTimeout` (which is still used for HTTP 408), network
+  timeouts will now raise either `RestClient::Exceptions::ReadTimeout` or
+  `RestClient::Exceptions::OpenTimeout`, both of which inherit from
+  `RestClient::Exceptions::Timeout`. For backwards compatibility, this still
+  inherits from `RestClient::RequestTimeout` so existing uses will still work.
+  This may change in a future major release. These new timeout classes also
+  make the original wrapped exception available as `#original_exception`.
+- Unify request exceptions under `RestClient::RequestFailed`, which still
+  inherits from `ExceptionWithResponse`. Previously, HTTP 304, 401, and 404
+  inherited directly from `ExceptionWithResponse` rather than from
+  `RequestFailed`. Now _all_ HTTP status code exceptions inherit from both.
 - Rename `:timeout` to `:read_timeout`. When `:timeout` is passed, now set both
   `:read_timeout` and `:open_timeout`.
 - Change default HTTP Accept header to `*/*`
@@ -59,6 +65,14 @@ This release is largely API compatible, but makes several breaking changes.
   possible to add procs like `RestClient.add_before_execution_proc` to a single
   request without global state.
 
+# 2.0.0.rc1
+
+Changes in the release candidate that did not persist through the final 2.0.0
+release:
+- RestClient::Exceptions::Timeout was originally going to be a direct subclass
+  of RestClient::Exception in the release candidate. This exception tree was
+  made a subclass of RestClient::RequestTimeout prior to the final release.
+
 # 1.8.0
 
 - Security: implement standards compliant cookie handling by adding a

data/lib/restclient/exceptions.rb

@@ -100,20 +100,16 @@ module RestClient
       @response.body if @response
     end
 
-    def inspect
-      "#{message}: #{http_body}"
-    end
-
     def to_s
-      inspect
+      message
     end
 
     def message
-      @message || self.class.default_message
+      @message || default_message
     end
 
-    def self.default_message
-      self.name
+    def default_message
+      self.class.name
     end
   end
 
@@ -124,7 +120,7 @@ module RestClient
   # The request failed with an error code not managed by the code
   class RequestFailed < ExceptionWithResponse
 
-    def message
+    def default_message
       "HTTP status code #{http_code}"
     end
 
@@ -141,11 +137,30 @@ module RestClient
   module Exceptions
     # Map http status codes to the corresponding exception class
     EXCEPTIONS_MAP = {}
+  end
+
+  # Create HTTP status exception classes
+  STATUSES.each_pair do |code, message|
+    klass = Class.new(RequestFailed) do
+      send(:define_method, :default_message) {"#{http_code ? "#{http_code} " : ''}#{message}"}
+    end
+    klass_constant = const_set(message.delete(' \-\''), klass)
+    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+  end
+
+  # Backwards compatibility. "Not Found" is the actual text in the RFCs.
+  ResourceNotFound = NotFound
+
+  module Exceptions
+    # We have to split the Exceptions module like we do here because the
+    # EXCEPTIONS_MAP is under Exceptions, but we depend on
+    # RestClient::RequestTimeout below.
 
     # Base class for request timeouts.
+    #
     # NB: Previous releases of rest-client would raise RequestTimeout both for
     # HTTP 408 responses and for actual connection timeouts.
-    class Timeout < RestClient::Exception
+    class Timeout < RestClient::RequestTimeout
       def initialize(message=nil, original_exception=nil)
         super(nil, nil)
         self.message = message if message
@@ -156,7 +171,7 @@ module RestClient
     # Timeout when connecting to a server. Typically wraps Net::OpenTimeout (in
     # ruby 2.0 or greater).
     class OpenTimeout < Timeout
-      def self.default_message
+      def default_message
         'Timed out connecting to server'
       end
     end
@@ -164,25 +179,12 @@ module RestClient
     # Timeout when reading from a server. Typically wraps Net::ReadTimeout (in
     # ruby 2.0 or greater).
     class ReadTimeout < Timeout
-      def self.default_message
+      def default_message
         'Timed out reading data from server'
       end
     end
   end
 
-  STATUSES.each_pair do |code, message|
-
-    # Compatibility
-    superclass = ([304, 401, 404].include? code) ? ExceptionWithResponse : RequestFailed
-    klass = Class.new(superclass) do
-      send(:define_method, :message) {"#{http_code ? "#{http_code} " : ''}#{message}"}
-    end
-    klass_constant = const_set message.delete(' \-\''), klass
-    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
-  end
-
-  # Backwards compatibility. "Not Found" is the actual text in the RFCs.
-  ResourceNotFound = NotFound
 
   # The server broke the connection prior to the request completing.  Usually
   # this means it crashed, or sometimes that your network connection was

data/lib/restclient/request.rb

@@ -248,6 +248,7 @@ module RestClient
           end
         end
 
+        user_headers = user_headers.dup
         user_headers[:cookie] = @cookies.map { |key, val| "#{key}=#{val}" }.sort.join('; ')
       end
       headers = stringify_headers(default_headers).merge(stringify_headers(user_headers))

data/lib/restclient/version.rb

@@ -1,5 +1,5 @@
 module RestClient
-  VERSION_INFO = [2, 0, 0, 'rc1'] unless defined?(self::VERSION_INFO)
+  VERSION_INFO = [2, 0, 0, 'rc2'] unless defined?(self::VERSION_INFO)
   VERSION = VERSION_INFO.map(&:to_s).join('.') unless defined?(self::VERSION)
 
   def self.version

data/spec/unit/exceptions_spec.rb

@@ -84,4 +84,19 @@ describe "backwards compatibility" do
   it 'aliases RestClient::NotFound as ResourceNotFound' do
     RestClient::ResourceNotFound.should eq RestClient::NotFound
   end
+
+  it 'subclasses NotFound from RequestFailed, ExceptionWithResponse' do
+    RestClient::NotFound.should be < RestClient::RequestFailed
+    RestClient::NotFound.should be < RestClient::ExceptionWithResponse
+  end
+
+  it 'subclasses timeout from RestClient::RequestTimeout, RequestFailed, EWR' do
+    RestClient::Exceptions::OpenTimeout.should be < RestClient::Exceptions::Timeout
+    RestClient::Exceptions::ReadTimeout.should be < RestClient::Exceptions::Timeout
+
+    RestClient::Exceptions::Timeout.should be < RestClient::RequestTimeout
+    RestClient::Exceptions::Timeout.should be < RestClient::RequestFailed
+    RestClient::Exceptions::Timeout.should be < RestClient::ExceptionWithResponse
+  end
+
 end

data/spec/unit/request_spec.rb

@@ -383,6 +383,19 @@ describe RestClient::Request, :include_helpers do
     lambda { @request.transmit(@uri, 'req', nil) }.should raise_error(RestClient::Exceptions::OpenTimeout)
   end
 
+  it "uses correct error message for ReadTimeout",
+     :if => defined?(Net::ReadTimeout) do
+    @http.stub(:request).and_raise(Net::ReadTimeout)
+    lambda { @request.transmit(@uri, 'req', nil) }.should raise_error(RestClient::Exceptions::ReadTimeout, 'Timed out reading data from server')
+  end
+
+  it "uses correct error message for OpenTimeout",
+     :if => defined?(Net::OpenTimeout) do
+    @http.stub(:request).and_raise(Net::OpenTimeout)
+    lambda { @request.transmit(@uri, 'req', nil) }.should raise_error(RestClient::Exceptions::OpenTimeout, 'Timed out connecting to server')
+  end
+
+
   it "class method execute wraps constructor" do
     req = double("rest request")
     RestClient::Request.should_receive(:new).with(1 => 2).and_return(req)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-client
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0.rc2
 platform: ruby
 authors:
 - REST Client Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock